SystemConfig

系统配置(SystemConfig)

[GET] /api/v2/identity/sys-config

获取系统配置记录。

响应

状态代码: 200

成功

SystemConfigModel

[PUT] /api/v2/identity/sys-config

更新系统配置。

请求模式

SystemConfigBizModel

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

状态代码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/sys-config/name

更新公司名称。

请求模式

data

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

[PUT] /api/v2/identity/sys-config/icon

更新系统图标。

请求模式

data

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

[GET] /api/v2/identity/sys-config/icon

获取系统图标。

响应

状态代码: 200

成功

byte

[PUT] /api/v2/identity/sys-config/logo

更新登录页面中显示的图标。

请求模式

data

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

[PUT] /api/v2/identity/sys-config/bgimage

更新登录页面显示的背景图片。

请求模式

data

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

[GET] /api/v2/identity/sys-config/password-policy

获取系统密码策略。

响应

状态代码: 200

成功

PasswordPolicyInfoModel

[PUT] /api/v2/identity/sys-config/password-policy

更新系统密码策略。

请求模式

data

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

[GET] /api/v2/identity/sys-config/locked-time

获取用户锁定时间。

响应

状态代码: 200

成功

int32

[PUT] /api/v2/identity/sys-config/locked-time

更新用户锁定时间。

请求模式

int32

响应

状态代码: 204

成功

[GET] /api/v2/identity/sys-config/show-global-organization

检索全局组织是否已启用。

响应

状态代码: 200

成功

[PUT] /api/v2/identity/sys-config/css

更新自定义 CSS 内容。

请求模式

data

响应

状态代码: 204

成功

[PUT] /api/v2/identity/sys-config/html

更新自定义 HTML 内容。

请求模式

data

响应

状态代码: 204

成功

[GET] /api/v2/identity/sys-config/email-settings

获取电子邮件设置。

响应

状态代码: 200

成功

EmailSettingSMTPSettings

状态代码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/sys-config/email-settings

更新电子邮件设置。

请求模式

EmailSettingSMTPSettings

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

[GET] /api/v2/identity/sys-config/security-settings

获取与安全相关的设置，包括“PasswordPolicy”、“LockedTime”、“AllowUserResetPassword”和“CookieLifetime”。

响应

状态代码: 200

成功

SystemConfigSecuritySettings

[PUT] /api/v2/identity/sys-config/security-settings

更新安全相关设置，包括“PasswordPolicy”、“LockedTime”、“AllowUserResetPassword”和“CookieLifetime”。

请求模式

SystemConfigSecuritySettings

响应

状态代码: 204

成功

状态代码: 400

错误请求

ApiErrorResult

[POST] /api/v2/identity/sys-config/global-organization

显示/隐藏全局组织。

请求模式

boolean

响应

状态代码: 204

成功

模型定义

Ƭ SystemConfigModel

名称	类型	描述	示例
securitySettings	SystemConfigSecuritySettings
customView	SystemConfigCustomView
viewDecorations	SystemConfigViewDecorations
preferences	SystemConfigPreferences

Ƭ SystemConfigSecuritySettings

名称	类型	描述	示例
passwordPolicy	PasswordPolicy
lockedTime	int32	用户被锁定的时长，单位为分钟	`60`
allowUserResetPassword	Boolean	是否运行用户重置密码
defaultCookieLifetime可为空	int32	登录时未勾选“记住我”选项的用户的 cookie 过期时间，以天为单位。
cookieLifetimeForRememberLogin可为空	int32	登录时选中“记住我”选项的用户的 cookie 过期时间，以天为单位。	`14`

Ƭ SystemConfigCustomView

名称	类型	描述	示例
loginPageTip可为空	string
css可为空	string
html可为空	string

Ƭ SystemConfigViewDecorations

名称	类型	描述	示例
logo可为空	string
bgImage可为空	string

Ƭ SystemConfigPreferences

名称	类型	描述	示例
companyName可为空	string
sysIcon可为空	string
showGlobalTenant	Boolean

Ƭ PasswordPolicy

Enum:

WeakPasswordPolicy
NormalPasswordPolicy
StrongPasswordPolicy

密码策略。

* WeakPasswordPolicy - 0 - 弱密码策略。
* NormalPasswordPolicy - 10 - 正常的密码策略。
* StrongPasswordPolicy - 20 - 强密码策略。

Ƭ ApiErrorResult

该模型用于描述处理 Web 请求时发生的所有错误。

名称	类型	描述	示例
errors可为空	ApiError	错误列表。

Ƭ ApiError

该模型用于描述处理 Web 请求时发生的错误。

名称	类型	描述
code可为空	string	错误的唯一标识。
message可为空	string	错误的描述文本。
context可为空	string	错误的一些相关上下文信息。

Ƭ SystemConfigBizModel

名称	类型	描述	示例
companyName可为空	string	系统标题。	`"Wyn Enterprise"`
sysIcon可为空	string	系统图标的 base64 字符串。	`"data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."`
logo可为空	string	登录页面logo的base64字符串。	`"data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."`
bgImage可为空	string	登录页面背景图片的base64字符串。	`"data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."`
passwordPolicy	PasswordPolicy
lockedTime可为空	int32	多次无效登录的锁定时间，单位为分钟。	`60`
loginPageTip可为空	string	登录页面的提示信息。	`"This is just a tip."`
css可为空	string	自定义 CSS 内容。	`"body { font-family: sans-serif; }"`
html可为空	string	自定义 HTML 内容。	`"Custom HTML Content"`
allowUserResetPassword可为空	Boolean	是否允许用户重设密码。	`true`
showGlobalTenant可为空	Boolean	登录时是否显示“全局”组织。	`true`
defaultCookieLifetime可为空	int32	登录时未勾选“记住我”选项的用户的 cookie 过期时间，以天为单位。
cookieLifetimeForRememberLogin可为空	int32	登录时选中“记住我”选项的用户的 cookie 过期时间，以天为单位。	`14`

Ƭ PasswordPolicyInfoModel

名称	类型	描述	示例
name可为空	string	密码策略的名称。
value	int32	密码策略的代表值。

Ƭ EmailSettingSMTPSettings

名称	类型	描述	示例
serverAddress可为空	string	SMTP 服务器地址。	`"smtp.gmail.com"`
serverPort	int32	SMTP服务的监听端口。	`465`
enableSSL	Boolean	是否启用 SSL 协议。	`true`
userName可为空	string	登录SMTP服务的用户名。	`"example@gmail.com"`
password可为空	string	用户的密码。	`"MyPassword"`
senderName可为空	string	电子邮件发件人的显示名称。	`"MyDisplayName"`
senderEmail可为空	string	电子邮件发件人的显示电子邮件地址。	`"example@gmail.com"`
emailSenderType	EmailSenderType
googleClientId可为空	string	Google 邮件服务的客户端 ID。	`"your_client_id"`
googleClientSecret可为空	string	Google 邮件服务的客户端密码。	`"your_client_secret"`
googleTokens可为空	string	为使用 Google 邮件服务发送电子邮件而生成的令牌。	`"generated_token"`

Ƭ EmailSenderType

Enum:

SMTP
GoogleAPI

电子邮件发件人类型。

* SMTP - 0 - 使用 SMTP 协议发送电子邮件。
* GoogleAPI - 1 - 使用 Google API 发送电子邮件。